Add websocket entrypoint for app #26

Sotatek-JohnnyNguyen · 2024-04-23T08:44:25Z

No description provided.

src/events.module.ts

georgefuru · 2024-05-09T14:03:53Z

src/config/configuration.ts

@@ -23,4 +23,6 @@ export default () => ({
    /^eth_.*Filter$/,
  ],
  inheritHostHeader: true,
+  wsPort: process.env.WS_PORT,


@Sotatek-JohnnyNguyen
Is "wsPort" being used anywhere? If it is not being used, please remove it.

georgefuru · 2024-05-10T06:33:43Z

src/services/webSocket.sevice.ts

+      return false;
+    }
+    return true;
+  }


@Sotatek-JohnnyNguyen
If it were me, I would write the code as shown below.
Is there any reason you have written it this way?

isConnected() { return (this.socket.readyState == this.socket.OPEN); }

sorry! you're right, let me change this

georgefuru · 2024-05-10T07:23:47Z

.env.example

+VERSE_READ_NODE_URL=http://localhost:8545
+BLOCK_NUMBER_CACHE_EXPIRE_SEC=
+DATASTORE=
+NODE_SOCKET=ws://[::]:8546


@Sotatek-JohnnyNguyen
.env.example file has been added, but how is it intended to be used?
It appears that dotenv is not included in the package.json.
Will you use the source .env command?

And it would be helpful if you could also update the README.md file to reflect the current situation.

Although it is unrelated to this change, I believe that $ npm build in the README.md file should be corrected to $ npm run build.

First: Nestjs provide configModule that exposes a configService which loads the appropriate .env file, so we dont need dotenv for now
Second: the .env.example is like an example to help other devs know which configuration variables they have to add to .env file in order to run the service

I will update README.me file now. Also yes both commands $ npm build and $ npm run build are doing the same action

@Sotatek-JohnnyNguyen
Okay. Thanks for replying.

First: Nestjs provide configModule that exposes a configService which loads the appropriate .env file, so we dont need dotenv for now

Good! Thanks.

Second: the .env.example is like an example to help other devs know which configuration variables they have to add to .env file in order to run the service

Of course, I know that. My way of asking the question might not have been good.

By the way, what do you think about including the environment variable PORT=, which is currently written to be exported in the README.md, in the .env.example file?
If there are no issues, I feel it would be good to add it.

sure

By the way, what do you think about including the environment variable PORT=, which is currently written to be exported in the README.md, in the .env.example file?
If there are no issues, I feel it would be good to add it.

georgefuru · 2024-05-16T04:37:21Z

README.md

+MAXRECONNECTATTEMPTS: 10
+```
+
+### 5. Set up npm


@Sotatek-JohnnyNguyen
There are two '5.'s.

5. Handle disconnect from node's websocket

5. Set up npm

sorry, my bad. let me fix this

georgefuru · 2024-05-16T04:52:51Z

.env.example

+DATASTORE=redis
+NODE_SOCKET=ws://[::]:8546
+PORT=3000
+REDIS_URI=redis://localhost:6373


@Sotatek-JohnnyNguyen
I believe the default port for Redis is 6379. Is there a specific reason it was changed to 6373?

I used 6373 for my redis

@Sotatek-JohnnyNguyen
https://github.com/oasysgames/verse-proxy/blob/fc1b97ce63bcb370bffbda97419523cdb95c89c8/docs/RateLimit.md?plain=1

Since the above mentions REDIS, please adjust the README as needed.

https://github.com/oasysgames/verse-proxy/blob/master/docs/RateLimit.md

I think it would be preferable to list DATASTORE and REDIS_URI side by side.
And Redis' default port is 6379, so I think
REDIS_URI=redis://localhost:6379
is better.

@Sotatek-JohnnyNguyen
Have you checked the above comment?

I have, but from my perspective, I don't think we need to change anything here since the README tells what it needs to tell about the datastore config.

Please review my commit

…t occurs

ironbeer

Need a request routing features to master node and reader node (replica node) similar to an HTTP proxy. Do not need to consider session affinity for WebSocket sessions.(Do not need to consider session affinity for WS sessions.)

When only VERSE_URL (also known as VERSE_MASTER_NODE_URL) is set
Proxy all requests to the master node.

When VERSE_READ_NODE_URL is also set
Proxy eth_sendRawTransaction and eth_estimateGas requests to the master node.
Proxy all other requests to the reader node.

Code: https://github.com/oasysgames/verse-proxy/blob/features/add-support-web-socket/src/services/proxy.service.ts#L84-L104

ironbeer

If the environment variable for the WebSocket origin address does not configured, the process will crash. Since the WebSocket proxy is an optional feature, please ensure it is only enabled if the environment variable is present.

src/services/webSocket.sevice.ts

Sotatek-JohnnyNguyen · 2024-05-17T08:07:59Z

Need a request routing features to master node and reader node (replica node) similar to an HTTP proxy. Do not need to consider session affinity for WebSocket sessions.(Do not need to consider session affinity for WS sessions.)

When only VERSE_URL (also known as VERSE_MASTER_NODE_URL) is set Proxy all requests to the master node.

When VERSE_READ_NODE_URL is also set Proxy eth_sendRawTransaction and eth_estimateGas requests to the master node. Proxy all other requests to the reader node.

Code: https://github.com/oasysgames/verse-proxy/blob/features/add-support-web-socket/src/services/proxy.service.ts#L84-L104

That means the verse-proxy may have to keep 2 web-sockets connection to master node and reader node right?

ironbeer · 2024-05-17T10:38:14Z

Need a request routing features to master node and reader node (replica node) similar to an HTTP proxy. Do not need to consider session affinity for WebSocket sessions.(Do not need to consider session affinity for WS sessions.)
When only VERSE_URL (also known as VERSE_MASTER_NODE_URL) is set Proxy all requests to the master node.
When VERSE_READ_NODE_URL is also set Proxy eth_sendRawTransaction and eth_estimateGas requests to the master node. Proxy all other requests to the reader node.
Code: https://github.com/oasysgames/verse-proxy/blob/features/add-support-web-socket/src/services/proxy.service.ts#L84-L104

That means the verse-proxy may have to keep 2 web-sockets connection to master node and reader node right?

yes

…t-formatter Apply formatter

ironbeer

@Sotatek-JohnnyNguyen I found a bug that causes mixed responses when multiple clients are connected.
If you build and run the test command in this repository(or using ethers.js, etc.), it will subscribe to newHeads, so if you create another connection with wscat, etc. in that state, the response should show up.

Additionally, I found an issue where subscriptions from disconnected clients remain and responses are being sent to other clients. This phenomenon can also be reproduced with the previously mentioned command.

Sotatek-PhucTa and others added 7 commits April 23, 2024 14:39

Add websocket entrypoint for app

9e658d1

Add subscribe for event execute

55c1f23

Integrate with communicate service for furthur handling

8ecfd0f

Add test for method not allowed

48b4744

feat: implement swith method when emit ws

f7a0ed8

chore: define response for event ws

cf364c0

chore: update unit test for metho net_version

4e55ad3

ironbeer reviewed May 2, 2024

View reviewed changes

src/events.module.ts Outdated Show resolved Hide resolved

Sotatek-JohnnyNguyen and others added 4 commits May 3, 2024 16:29

feat: change socket.io to websocket

18c2782

feat: change unit test from socketio to pure socket

c643b49

feat: refactor code

895947c

feat: refactor code

0b70808

georgefuru reviewed May 9, 2024

View reviewed changes

Sotatek-William added 2 commits May 10, 2024 09:54

remove wsPort, add .env.example file and comment unit test

2a401ca

add eth_subscribe and eth_unsubscribe to allowedMethods array

de5a966

georgefuru reviewed May 10, 2024

View reviewed changes

optimize code logic

8b341d5

georgefuru reviewed May 10, 2024

View reviewed changes

Sotatek-William added 10 commits May 10, 2024 14:58

add step Set configuration variables to README file

9e89e83

fix: check socket connection

a4dbb2d

check rate limit if request is sendrawtransaction

f5390b5

check rate limit if request is sendrawtransaction

9687449

add-unit-test

cff24e1

add-unit-test

55f6bff

improve unit test

402e71e

add reconnect method

d21fe70

add reconnect method

db29b85

update README

85178a8

georgefuru reviewed May 16, 2024

View reviewed changes

fix README and keep the connection even if error from node's websocke…

f829080

…t occurs

ironbeer requested changes May 17, 2024

View reviewed changes

src/services/webSocket.sevice.ts Show resolved Hide resolved

fix: issues reported by BOT

15482a5

Sotatek-JohnnyNguyen and others added 6 commits May 21, 2024 10:40

update: communicate test file and README

62ff16c

update: communicate test file and README

ca56fda

update: .env.example file

d00874b

update: communicate test file

b72b24f

Apply formatter

b789678

Merge pull request #27 from oasysgames/features/add-support-web-socke…

bf0e2f4

…t-formatter Apply formatter

georgefuru approved these changes May 21, 2024

View reviewed changes

ironbeer requested changes May 21, 2024

View reviewed changes

ironbeer merged commit bf0e2f4 into master May 28, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add websocket entrypoint for app #26

Add websocket entrypoint for app #26

Sotatek-JohnnyNguyen commented Apr 23, 2024

georgefuru May 9, 2024

Sotatek-JohnnyNguyen May 10, 2024

georgefuru May 10, 2024

Sotatek-JohnnyNguyen May 10, 2024

georgefuru May 10, 2024

Sotatek-JohnnyNguyen May 10, 2024

Sotatek-JohnnyNguyen May 10, 2024

georgefuru May 10, 2024 •

edited

Loading

Sotatek-JohnnyNguyen May 10, 2024 •

edited

Loading

georgefuru May 16, 2024

Sotatek-JohnnyNguyen May 16, 2024

georgefuru May 16, 2024

Sotatek-JohnnyNguyen May 16, 2024

georgefuru May 16, 2024 •

edited

Loading

georgefuru May 21, 2024 •

edited

Loading

Sotatek-JohnnyNguyen May 21, 2024

Sotatek-JohnnyNguyen May 21, 2024

ironbeer left a comment •

edited

Loading

ironbeer left a comment

Sotatek-JohnnyNguyen commented May 17, 2024 •

edited

Loading

ironbeer commented May 17, 2024

ironbeer left a comment •

edited

Loading

Add websocket entrypoint for app #26

Add websocket entrypoint for app #26

Conversation

Sotatek-JohnnyNguyen commented Apr 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

georgefuru May 10, 2024 • edited Loading

Choose a reason for hiding this comment

Sotatek-JohnnyNguyen May 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

5. Handle disconnect from node's websocket

5. Set up npm

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

georgefuru May 16, 2024 • edited Loading

Choose a reason for hiding this comment

georgefuru May 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ironbeer left a comment • edited Loading

Choose a reason for hiding this comment

ironbeer left a comment

Choose a reason for hiding this comment

Sotatek-JohnnyNguyen commented May 17, 2024 • edited Loading

ironbeer commented May 17, 2024

ironbeer left a comment • edited Loading

Choose a reason for hiding this comment

georgefuru May 10, 2024 •

edited

Loading

Sotatek-JohnnyNguyen May 10, 2024 •

edited

Loading

georgefuru May 16, 2024 •

edited

Loading

georgefuru May 21, 2024 •

edited

Loading

ironbeer left a comment •

edited

Loading

Sotatek-JohnnyNguyen commented May 17, 2024 •

edited

Loading

ironbeer left a comment •

edited

Loading